home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / tncdr105.zip / TNC-DOOR.DOC < prev    next >
Text File  |  1992-05-08  |  16KB  |  325 lines
  1. TNC-DOOR Documentation       May 8, 1992                        V1.05
  2. --- ---- -------------
  3.  
  4. I. REGISTRATION
  5.  
  6. TNC-DOOR is SHAREWARE.  This software is FULLY FUNCTIONAL in every way.
  7. This is not "cripple-ware" or any other such nastiness.  However,
  8. TNC-DOOR is not FREE.  You are permitted to use this software for thirty
  9. days following the day on which you obtained it.  If you decide that
  10. TNC-DOOR is something that you want to continue using, REGISTER the
  11. software by doing ths following:
  12.  
  13. Send a check or money order for TWENTY DOLLARS (U.S.) to:
  14.  
  15.        Vincent Quaresima, K2NE
  16.        30 Marygold Avenue
  17.        Browns Mills, New Jersey 08015
  18.  
  19. This is a one-time LIFETIME registration, which will entitle you to the
  20. use of any future upgrade of the TNC-DOOR.  Upon receipt of your registration
  21. you will get a disk containing the latest version of the TNC-DOOR, along
  22. with any updates to this documentation file.  Please specify DISK SIZE and
  23. FORMAT (360K, 1.2 meg and 1.44 meg, 3.5 inch or 5.25 inch) when you register.
  24.  
  25. THIS SOFTWARE IS NOT FOR USE IN COMMERCIAL INSTALLATIONS.  Such use will be
  26. construed as a VIOLATION of COPYRIGHT.  It is illegal in the United States
  27. to use Amateur Radio for commercial purposes.  Please obey the law!
  28.  
  29. BEGINNING WITH VERSION 1.05, you will receive a REGISTRATION CODE NUMBER
  30. when you register your TNC DOOR software.  You will then, in return,
  31. receive instructions on how to REGISTER YOUR COPY of TNC-DOOR on your
  32. hard-disk.  REGISTRATION will eliminate those "Remember to REGISTER"
  33. announcements, and will also eliminate the "UNREGISTERED EVALUATION COPY"
  34. message that appears to your online user and replace it with a "kinder,
  35. gentler" sign-on note!
  36.  
  37. PLEASE NOTE:  ALL functions of TNC DOOR are available during your evaluation
  38. period.  I truly want to continue this policy, but it all depends on the
  39. willingness of you folks to REGISTER this work.
  40.  
  41.  
  42. II. WHAT YOU SHOULD FIND IN TNCDRxxx.ZIP
  43.  
  44.     a) The "xxx" in the filename corresponds to the version/release
  45.        number.  For example, V1.05 would be TNCDR105.ZIP, etc.
  46.     b) The file TNC-DOOR.EXE is the actual software.
  47.     c) The file TNC-DOOR.DOC is this file you are reading right now.
  48.     d) REGISTER.TNC is a "self-mailer" registration sheet.  Print it
  49.        on your printer in standard 80-col. mode for an "instant mailer."
  50.  
  51.     IF YOU ARE A FIDONET SYSOP and you obtained your TNC-DOOR package
  52.     by File Requesting it, then you may have received a ZIPfile not
  53.     conforming to this "version naming convention."  For example,
  54.     you can always F'req the latest version from Jersey Devil Citadel
  55.     at FIDO 1:266/33 by using the "magic name" TNC-DOOR, in which case
  56.     the FIDO mailer will send you TNC-DOOR.ZIP.  I always make sure that
  57.     TNC-DOOR.ZIP is the most current version, but other sysops may not
  58.     be so careful.
  59.  
  60.  
  61. III. HOW TO SET IT UP
  62.  
  63.     a) Make a directory from which this door will run.  The name of the
  64.        directory is NOT IMPORTANT.
  65.  
  66.     b) Using an ordinary ASCII text editor, create a file called
  67.        HAMUSERS.DAT, which goes in this directory.  The format of the
  68.        file is simple but CRITICAL.
  69.  
  70.        1st line: YOUR CALLSIGN
  71.        2nd line: NAME OF FIRST AUTHORIZED USER
  72.        3rd line: HIS CALLSIGN
  73.        4th line: NAME OF NEXT AUTHORIZED USER
  74.        5th line: HIS CALLSIGN
  75.  
  76.        ETC.
  77.  
  78.        A sample file follows:
  79.  
  80.        K2NE
  81.        vince quaresima
  82.        K2NE-1
  83.        terry rossi
  84.        N2LQH
  85.        brian riley
  86.        KA2BQE
  87.        jerry devine
  88.        KA2RRK
  89.        LAST ONE
  90.  
  91.        IT IS VERY IMPORTANT THAT THERE BE NOTHING AFTER THE LAST LINE OF THE
  92.        FILE.  THE LAST LINE OF THE FILE MUST BE TERMINATED WITH A CARRIAGE
  93.        RETURN!  As you can see from the example, the names and callsigns are
  94.        NOT "case sensitive."  The exception is the "LAST ONE" used as the
  95.        last line of the file.  This is used by the software as a redundant
  96.        method to prevent reading beyond the end of the file.
  97.  
  98.        If your BBS online user's name is in this file then he is an authorized
  99.        user of the TNC-DOOR.  If not, he isn't and he will get a message
  100.        telling him to contact you if he believes he is qualified to use the
  101.        door.  A user whose name is not in this file WILL NOT BE ABLE TO
  102.        ACCESS YOUR TNC!
  103.  
  104.        When an authorized user elects to run the TNC-DOOR, the software will
  105.        check for his name, and match this to his ham call, and will issue a
  106.        MYCALL to your TNC using HIS call.  That way, what he does "on the air"
  107.        will be his responsibility!
  108.  
  109.        When the user ends his packet session, another MYCALL is issued to the
  110.        TNC setting it back to YOUR call (which appears on the first line of
  111.        HAMUSERS.DAT).
  112.  
  113.     c) Use whatever is required to "tell your BBS" about the door.  This varies
  114.        depending on your BBS software, so there is no point in going through
  115.        it here.  Check your BBS documentation for assistance on this point.
  116.        You should be glad to know that the TNC-DOOR will automatically
  117.        recognize DORINFO1.DEF when it finds it IN the "TNC-DOOR" directory.
  118.        Use whatever "batch file magic" is needed to copy the DORINFO file that
  119.        your BBS generates into the TNC-DOOR's directory.  If you are running
  120.        your BBS on something other than COM1 (and hence generating DORINFO2.DEF
  121.        or DORINFO3.DEF, etc.) then simply rename as you move it.
  122.  
  123.        The TNC-DOOR will also recognize (and use) CTDLDOOR.DAT in place of
  124.        a DORINFO#.DEF file if it finds it.  Thus, this software should be
  125.        compatible with RBBS, any other BBS generating a DORINFO#.DEF file,
  126.        Citadel:K2NE, any other BBS generating a Citadel:K2NE-compatible
  127.        CTDLDOOR.DAT file, or any other "door information" file that can be
  128.        modified to LOOK like either of those (yes, there are utilities out
  129.        there that will modify "door information files" to look like them!).
  130.  
  131.  
  132.     d) TNC-DOOR's COMMAND LINE PARAMETERS:
  133.  
  134.        /? will show you the USAGE syntax.  In general, you should set it up
  135.        like this:
  136.  
  137.        TNC-DOOR bbs=1 tnc=2 tncbaud=2400 mycall=yourcall [local]
  138.  
  139.        "bbs=1" tells the door that the BBS is on COM1.  You may change this
  140.        to suit your situation.
  141.  
  142.        "tnc=2" tells the door that the TNC is on COM2.  You can change this.
  143.  
  144.        "tncbaud=2400" tells the door that your TNC is communicating with
  145.        your computer at 2400 bps.  You may change this.  Allowable settings
  146.        are tncbaud=300, tncbaud=1200, tncbaud=2400, tncbaud=4800, and
  147.        tnc-baud=9600.  NOTE THAT THIS HAS NOTHING TO DO WITH THE BAUDRATE
  148.        YOUR TNC USES WHILE TRANSMITTING "ON THE AIR."  Some TNCs are more
  149.        efficient than others (meaning some TNCs are slow clunkers!).  You
  150.        may have to fiddle with your TNCs baud setting (ABAUD is the command
  151.        on the KAM unit that was used for testing this software, yours may
  152.        differ so check your TNC instruction manual).
  153.  
  154.        "local" tells the TNC DOOR that the "user" is on your keyboard
  155.        rather than on the BBS modem.  See section VI below.
  156.  
  157.     e) Grabbing control from your online user
  158.  
  159.        You can terminate a user's TNC DOOR session by pressing CTRL D
  160.        or CTRL K from your system console.  This can be done at ANY TIME
  161.        although common sense would dictate that there are times that
  162.        you should be patient and wait (while your user is in the
  163.        middle of typing a message to a packet BBS or something similar!).
  164.        When you do this, the TNC DOOR will type out a message to your user.
  165.        That message will be whatever you put in the file PRE-EMPT.TXT if you
  166.        create such a file.  Otherwise, the message will be "Your TNC
  167.        session is being terminated by the Sysop."
  168.  
  169.  
  170. IV. OPTIONAL FILES FOR YOUR USER
  171.  
  172. The following files are OPTIONAL.  If they are present they will be used.
  173. If they are not present, the system will chug right along!
  174.  
  175.     a) APPLY.TXT - this is typed to your BBS user if he tries to access
  176.                    the TNC-DOOR and is NOT in your HAMUSERS.DAT file.
  177.     b) TNC-HELP.TXT - this is typed to your user when he issues a CTRL I
  178.                       command.
  179.     c) COMMANDS.TXT - this is typed to your user when he presses ? at any
  180.                       time when your TNC is NOT CONNECTED to another packet
  181.                       station.  Note:  this will create a problem if your TNC
  182.                       does not support DCD and report DCD to your computer.
  183.                       Please get back to me if this creates more hassles than
  184.                       it is worth and I will either remove it or figure out
  185.                       a better way of implementing it.
  186.     d) PRE-EMPT.TXT - this is the file that is typed to the user when you, as
  187.                       Sysop, press CTRL D or CTRL K from your system console
  188.                       keyboard.  If this file is missing, a hard-coded message
  189.                       is sent to the user instead.  See above for more details.
  190.  
  191. In any case, you are left to your own creativity in writing these files.
  192.  
  193. V.  The TNC logging file
  194.  
  195. The TNC-DOOR automatically creates (or appends if it already exists) a file
  196. called TNC.LOG.  This file will automatically record the date, time, username,
  197. and amateur callsign of each user as the user begins his TNC-DOOR session.
  198. This file can be read by pressing "!" while using TNC-DOOR (as long as the
  199. TNC is not in a "connected" state).
  200.  
  201. WARNING:  TNC.LOG will "grow without end" if you do not maintain it.
  202.           I recommend that you set up a weekly event in your main BBS
  203.           scheduler to back it up and then delete it so that TNC-DOOR
  204.           can restart it with a "fresh start."  This can probably be
  205.           "stretched" to more than a week, depending on how active your
  206.           TNC-DOOR becomes (and how large a log file you are willing or
  207.           able to tolerate on your hard disk!).  FCC regulations no longer
  208.           require a "written log of station activity" as in years past.
  209.           This facility is a "sentimental throwback" but some may find
  210.           it useful.
  211.  
  212. VI. The LOCAL mode (Packet Terminal Operation)
  213.  
  214. If you use the "local" parameter when activating TNC-DOOR, the following
  215. happens:
  216.  
  217. 1) The sysop callsign is grabbed from the command line rather than from
  218.    the HAMUSERS.DAT file.
  219.  
  220. 2) The user's callsign is set to the same as the sysop's call.
  221.  
  222. 3) The bbs= parameter is ignored since input will be expected from the
  223.    local console keyboard rather than from a user on a BBS modem.
  224.  
  225. 4) TNC-DOOR will not check for any "door information file" since for
  226.    LOCAL use, none of the information which would be in such a file would
  227.    be needed.  The software "knows" you are on the keyboard, and from the
  228.    setting of the MYCALL= parameter, the software "knows" who you are.
  229.  
  230. 5) You can now directly access your TNC from the keyboard.  Originally,
  231.    my intention was to provide a "very simple 'dumb' terminal" however,
  232.    like a good story, it "grew in the telling."  The next few paragraphs
  233.    will explain to you exactly what terminal features are supported in this
  234.    release of the software.  I am not guaranteeing that future versions
  235.    will add features, but...
  236.  
  237. 6) You can CAPTURE your packet session to a disk file.  To begin
  238.    the CAPTURE session, type CTRL B.  You will be prompted for a filename
  239.    to call your CAPTURE file.  The DEFAULT filename is TNCBUFF.TXT.
  240.    If you pick a file that already exists, your session will be APPENDED
  241.    to the existing file, even if it is the DEFAULT file.  To end your
  242.    CAPTURE session, type CTRL B once again.  It is a "toggle."
  243.  
  244. 7) File "uploading" can be done by pressing CTRL F once you are connected
  245.    to another packet system (or another ham packet station).  You will
  246.    be prompted for the filename to send.  If it cannot be opened for sending
  247.    you will be informed of the error, otherwise the file will then IMMEDIATELY
  248.    be sent to your TNC for processing.  XON/XOFF flow control is ACTIVE
  249.    while TNC DOOR is sending the file.  You should set your TNCs "XFLOW"
  250.    parameter accordingly.  TNC DOOR expects $11 and $13 for XON and XOFF
  251.    respectively.  If your TNC can't be configured this way then you should
  252.    NOT use TNC DOOR for file-sending.  Also, there is nothing in TNC DOOR
  253.    to "check" the file to be sure it only contains printable ASCII.  Thus
  254.    you will have to resort to external means to "convert" binary files that
  255.    you may want to send to another packet station or packet BBS.  Since you
  256.    are using a packet TNC, there is no error-checking in the software.  You
  257.    can rely on AX.25 to handle that for you "automagically."
  258.  
  259. 8) You can READ a file from your disk.  To do this press CTRL R and the
  260.    TNC DOOR software will then prompt you for the name of the file you
  261.    want to read.  While reading, press P or the SPACEBAR to pause the
  262.    display.  Press any other key to resume the display.  Press N or S
  263.    to abort the display and end the READ session.
  264.  
  265. 9) To exit TNC-DOOR from the LOCAL mode, press CTRL D or CTRL K.
  266.  
  267. VII. CHATTING with your user
  268.  
  269. At the top of the screen (when the user is logged in) you will see
  270. "<ESC> toggles CHAT".  Very simple.  If you want to CHAT with your user,
  271. press ESC and you put TNC-DOOR into a local chat mode.  All TNC activity
  272. will be IGNORED while in chat mode.  To exit from chat mode back to the
  273. TNC (release your user back to the packet session) just press ESC again.
  274.  
  275. This might be handy if you are a sysop that prefers being "polite" and
  276. asking your user to exit the door "in person" rather than CTRL D or
  277. CTRL K to simply send him a message and boot him back to the BBS.
  278.  
  279. Obviously, this would also be handy if you are running TNC-DOOR from
  280. a system that does not support its own chat facility and you simply
  281. want to "talk" to your user.
  282.  
  283. ------------------------------------------------------------------------------
  284.  
  285. BUG FIXES and OTHER ADMINISTRIVIA:
  286.  
  287.  a) Sometimes when there is "garbage" in the TNC buffer the MYCALL
  288.     parameter was not being properly set.  This is fixed (V1.05).
  289.  b) TNC-to-HostComputer baudrate of 4800 Bps is now supported by the
  290.     "TNCBAUD=" command-line parameter.  (V1.05).
  291.  
  292. ------------------------------------------------------------------------------
  293.  
  294. And that's about all there is to it!  Please send any suggestions for
  295. enhancements or improvements, along with any "bug reports" to:
  296.  
  297.               Vince Quaresima, K2NE
  298.               30 Marygold Avenue
  299.               Browns Mills, New Jersey 08015
  300.  
  301. And PLEASE don't forget to REGISTER this software!  Only by registering
  302. do you help keep good and inexpensive software coming your way.
  303.  
  304. ------------------------------------------------------------------------------
  305.  
  306. Acknowledgments:
  307.  
  308. My thanks to Jerry Devine, KA2RRK, who patiently tolerated the lengthy
  309. testing sessions during the debugging of this software.  In addition,
  310. my thanks go to the many packet and landline sysops who have passed
  311. messages concerning this software, and who have made copies of this
  312. software available for online downloading.
  313.  
  314. ------------------------------------------------------------------------------
  315.  
  316. TNC-DOOR is COPYRIGHT 1992 by Vince Quaresima, K2NE (t/a K2NE Software).
  317. All rights are reserved.  Uploading to electronic databases (free or
  318. commercial) is both PERMITTED and ENCOURAGED.  Swapping or giving the
  319. software away is also permitted.  You may NOT charge for this software
  320. other than a minimal fee to cover the expense of duplicating your disk.
  321.  
  322. SHAREWARE VENDORS:  You are asked to include this software in your collection
  323. of programs.  You are also authorized to sell this software at a price
  324. NOT TO EXCEED FIVE DOLLARS (U.S. funds).  Such a sale does NOT constitute
  325. registration by the end user.